Match parameter names with the headers.

2006-04-24  Matthias Clasen  <mclasen@redhat.com>

	* gtk/gtkclipboard.h:
	* gtk/gtkprinter.c:
	* gtk/gtkprintsettings.h:
	* gtk/gtkprintsettings.c: Match parameter names with the headers.

	* gtk/gtkprintoperation-unix.c (gtk_print_run_page_setup_dialog):
	Add docs.

	* gtk/gtktextbufferrichtext.c (gtk_text_buffer_deserialize):
	* gtk/gtkstatusicon.c (gtk_status_icon_get_storage_type):
	* gtk/gtktreeview.c (gtk_tree_view_set_search_position_func):
	* gtk/gtktreeview.c (gtk_tree_view_get_headers_clickable):
	* gtk/gtkcellrendererspin.c (gtk_cell_renderer_spin_new):
	* gtk/gtkmenu.c (gtk_menu_get_for_attach_widget): Fix the docs.

diff --git a/ChangeLog b/ChangeLog
index c39b6e5c49c9c35abad9c314c4d82a286267748f..405c27f6f45d8519335750a1508149c3a32bbae6 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,20 @@
 2006-04-24  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkclipboard.h: 
+       * gtk/gtkprinter.c: 
+       * gtk/gtkprintsettings.h: 
+       * gtk/gtkprintsettings.c: Match parameter names with the headers.
+
+       * gtk/gtkprintoperation-unix.c (gtk_print_run_page_setup_dialog): 
+       Add docs.
+
+       * gtk/gtktextbufferrichtext.c (gtk_text_buffer_deserialize): 
+       * gtk/gtkstatusicon.c (gtk_status_icon_get_storage_type): 
+       * gtk/gtktreeview.c (gtk_tree_view_set_search_position_func): 
+       * gtk/gtktreeview.c (gtk_tree_view_get_headers_clickable): 
+       * gtk/gtkcellrendererspin.c (gtk_cell_renderer_spin_new): 
+       * gtk/gtkmenu.c (gtk_menu_get_for_attach_widget): Fix the docs.
+
        * gtk/gtkprinter.h: Don't declare GtkPrintJob here.
        * gtk/gtkprinter-private.h: Instead include gtkprintjob.h.
 

diff --git a/ChangeLog.pre-2-10 b/ChangeLog.pre-2-10
index c39b6e5c49c9c35abad9c314c4d82a286267748f..405c27f6f45d8519335750a1508149c3a32bbae6 100644 (file)
--- a/ChangeLog.pre-2-10
+++ b/ChangeLog.pre-2-10
@@ -1,5 +1,20 @@
 2006-04-24  Matthias Clasen  <mclasen@redhat.com>
 
+       * gtk/gtkclipboard.h: 
+       * gtk/gtkprinter.c: 
+       * gtk/gtkprintsettings.h: 
+       * gtk/gtkprintsettings.c: Match parameter names with the headers.
+
+       * gtk/gtkprintoperation-unix.c (gtk_print_run_page_setup_dialog): 
+       Add docs.
+
+       * gtk/gtktextbufferrichtext.c (gtk_text_buffer_deserialize): 
+       * gtk/gtkstatusicon.c (gtk_status_icon_get_storage_type): 
+       * gtk/gtktreeview.c (gtk_tree_view_set_search_position_func): 
+       * gtk/gtktreeview.c (gtk_tree_view_get_headers_clickable): 
+       * gtk/gtkcellrendererspin.c (gtk_cell_renderer_spin_new): 
+       * gtk/gtkmenu.c (gtk_menu_get_for_attach_widget): Fix the docs.
+
        * gtk/gtkprinter.h: Don't declare GtkPrintJob here.
        * gtk/gtkprinter-private.h: Instead include gtkprintjob.h.
 

diff --git a/gtk/gtkcellrendererspin.c b/gtk/gtkcellrendererspin.c
index 5d181cf872bdce37a3a9ec68e4ef2b0e80abb811..23232a63b7b101c7b8fcb0725f9eec46a5081d7d 100644 (file)
--- a/gtk/gtkcellrendererspin.c
+++ b/gtk/gtkcellrendererspin.c
@@ -323,6 +323,8 @@ gtk_cell_renderer_spin_start_editing (GtkCellRenderer     *cell,
  *
  * Creates a new #GtkCellRendererSpin. 
  *
+ * Returns: a new #GtkCellRendererSpin
+ *
  * Since: 2.10
  */
 GtkCellRenderer *

diff --git a/gtk/gtkclipboard.h b/gtk/gtkclipboard.h
index 46e9ea6b36587cbe4d986d0b2715cb5dd7bf79ea..1825cf767050cf8238a8bea25dbebc345ef7f18e 100644 (file)
--- a/gtk/gtkclipboard.h
+++ b/gtk/gtkclipboard.h
@@ -115,7 +115,7 @@ gchar *           gtk_clipboard_wait_for_text      (GtkClipboard  *clipboard);
 guint8 *          gtk_clipboard_wait_for_rich_text (GtkClipboard  *clipboard,
                                                     GtkTextBuffer *buffer,
                                                     GdkAtom       *format,
-                                                    gsize         *size);
+                                                    gsize         *length);
 GdkPixbuf *       gtk_clipboard_wait_for_image     (GtkClipboard  *clipboard);
 gboolean          gtk_clipboard_wait_for_targets   (GtkClipboard  *clipboard,
                                                     GdkAtom      **targets,

diff --git a/gtk/gtkmenu.c b/gtk/gtkmenu.c
index a31a67068446cb490c17cd42efa3fc914bd8a8d2..cb406b2680e7d89da6de172185ed60276272ca33 100644 (file)
--- a/gtk/gtkmenu.c
+++ b/gtk/gtkmenu.c
@@ -4783,7 +4783,8 @@ gtk_menu_set_monitor (GtkMenu *menu,
 /**
  * gtk_menu_get_for_attach_widget:
  * @widget: a #GtkWidget
- * * Returns a list of the menus which are attached to this widget.
+ *
+ * Returns a list of the menus which are attached to this widget.
  * This list is owned by GTK+ and must not be modified.
  *
  * Return value: the list of menus attached to his widget.

diff --git a/gtk/gtkprinter.c b/gtk/gtkprinter.c
index 2fd25abcdd85c297044e3d4d7f2b2302a5f40474..264a5084d32375edf191e2da90d5d97888a7d7e4 100644 (file)
--- a/gtk/gtkprinter.c
+++ b/gtk/gtkprinter.c
@@ -298,7 +298,7 @@ gtk_printer_get_property (GObject    *object,
  * gtk_printer_new:
  * @name: the name of the printer
  * @backend: a #GtkPrintBackend
- * @gboolean: whether the printer is virtual
+ * @virtual: whether the printer is virtual
  *
  * Creates a new #GtkPrinter.
  *

diff --git a/gtk/gtkprintoperation-unix.c b/gtk/gtkprintoperation-unix.c
index 936bc521af6bca7bd687910d21285d24116e07e9..1257fc0db8e0e258f1fa4c72c401eda3e8c839b2 100644 (file)
--- a/gtk/gtkprintoperation-unix.c
+++ b/gtk/gtkprintoperation-unix.c
@@ -215,6 +215,22 @@ _gtk_print_operation_platform_backend_run_dialog (GtkPrintOperation *op,
   return result;
 }
 
+/**
+ * gtk_print_run_page_setup_dialog:
+ * @parent: transient parent, or %NULL
+ * @page_setup: an existing #GtkPageSetup, or %NULL
+ * @settings: a #GtkPrintSettings
+ * 
+ * Runs a page setup dialog, letting the user modify 
+ * the values from @page_setup. If the user cancels
+ * the dialog, the returned #GtkPageSetup is identical
+ * to the passed in @page_setup, otherwise it contains
+ * the modifications done in the dialog.
+ * 
+ * Return value: a new #GtkPageSetup
+ *
+ * Since: 2.10
+ */
 GtkPageSetup *
 gtk_print_run_page_setup_dialog (GtkWindow        *parent,
                                 GtkPageSetup     *page_setup,

diff --git a/gtk/gtkprintsettings.c b/gtk/gtkprintsettings.c
index 5bd47202c394afd8cae33194b1cb4de5deedcc24..2cac68f2f55ea3f11df211f7778e7d5918f5ea79 100644 (file)
--- a/gtk/gtkprintsettings.c
+++ b/gtk/gtkprintsettings.c
@@ -385,7 +385,7 @@ gtk_print_settings_get_length (GtkPrintSettings *settings,
  * gtk_print_settings_set_length:
  * @settings: a #GtkPrintSettings
  * @key: a key
- * @length: a length
+ * @value: a length
  * @unit: the unit of @length
  * 
  * Associates a length in units of @unit with @key.
@@ -395,11 +395,11 @@ gtk_print_settings_get_length (GtkPrintSettings *settings,
 void
 gtk_print_settings_set_length (GtkPrintSettings *settings,
                               const gchar      *key,
-                              gdouble           length, 
+                              gdouble           value, 
                               GtkUnit           unit)
 {
   gtk_print_settings_set_double (settings, key,
-                                _gtk_print_convert_to_mm (length, unit));
+                                _gtk_print_convert_to_mm (value, unit));
 }
 
 /**
@@ -943,7 +943,7 @@ gtk_print_settings_get_quality (GtkPrintSettings *settings)
 /**
  * gtk_print_settings_set_quality:
  * @settings: a #GtkPrintSettings
- * @duplex: a #GtkPrintQuality value
+ * @quality: a #GtkPrintQuality value
  * 
  * Sets the value of %GTK_PRINT_SETTINGS_QUALITY.
  * 
@@ -1088,7 +1088,7 @@ gtk_print_settings_get_number_up (GtkPrintSettings *settings)
 /**
  * gtk_print_settings_set_number_up:
  * @settings: a #GtkPrintSettings
- * @num_copies: the number of pages per sheet 
+ * @number_up: the number of pages per sheet 
  * 
  * Sets the value of %GTK_PRINT_SETTINGS_NUMBER_UP.
  * 
@@ -1156,7 +1156,7 @@ gtk_print_settings_get_scale (GtkPrintSettings *settings)
 /**
  * gtk_print_settings_set_scale:
  * @settings: a #GtkPrintSettings
- * @resolution: the scale in percent
+ * @scale: the scale in percent
  * 
  * Sets the value of %GTK_PRINT_SETTINGS_SCALE.
  * 
@@ -1237,7 +1237,7 @@ gtk_print_settings_get_print_pages (GtkPrintSettings *settings)
 /**
  * gtk_print_settings_set_print_pages:
  * @settings: a #GtkPrintSettings
- * @print_pages: a #GtkPrintPages value
+ * @pages: a #GtkPrintPages value
  * 
  * Sets the value of %GTK_PRINT_SETTINGS_PRINT_PAGES.
  * 
@@ -1245,11 +1245,11 @@ gtk_print_settings_get_print_pages (GtkPrintSettings *settings)
  */
 void
 gtk_print_settings_set_print_pages (GtkPrintSettings *settings,
-                                   GtkPrintPages     print_pages)
+                                   GtkPrintPages     pages)
 {
   const gchar *str;
 
-  switch (print_pages)
+  switch (pages)
     {
     default:
     case GTK_PRINT_PAGES_ALL:

diff --git a/gtk/gtkprintsettings.h b/gtk/gtkprintsettings.h
index 3c5a748450545664a4d4be8544efe5e4f166e55a..8f20ee2c3856c3f6e03a99e94d9c8cd257b1621a 100644 (file)
--- a/gtk/gtkprintsettings.h
+++ b/gtk/gtkprintsettings.h
@@ -132,7 +132,7 @@ void               gtk_print_settings_set_paper_width    (GtkPrintSettings   *se
 gdouble            gtk_print_settings_get_paper_height   (GtkPrintSettings   *settings,
                                                          GtkUnit             unit);
 void               gtk_print_settings_set_paper_height   (GtkPrintSettings   *settings,
-                                                         gdouble             width,
+                                                         gdouble             height,
                                                          GtkUnit             unit);
 gboolean           gtk_print_settings_get_use_color      (GtkPrintSettings   *settings);
 void               gtk_print_settings_set_use_color      (GtkPrintSettings   *settings,

diff --git a/gtk/gtkstatusicon.c b/gtk/gtkstatusicon.c
index 85f4c813a51caffa3cfd48c9b6f60d113ad5f0c9..731e182d585ff26a23791404793c714c544d2bcf 100755 (executable)
--- a/gtk/gtkstatusicon.c
+++ b/gtk/gtkstatusicon.c
@@ -1126,7 +1126,7 @@ gtk_status_icon_set_from_icon_name (GtkStatusIcon *status_icon,
 
 /**
  * gtk_status_icon_get_storage_type:
- * @status_icon: 
+ * @status_icon: a #GtkStatusIcon
  * 
  * Gets the type of representation being used by the #GtkStatusIcon
  * to store image data. If the #GtkStatusIcon has no image data,

diff --git a/gtk/gtktextbufferrichtext.c b/gtk/gtktextbufferrichtext.c
index e2bf690c81d0c6e19bc17ed13444d28264ac2a3f..cdac9d432eb616d954ebf60a047734412e8259ad 100644 (file)
--- a/gtk/gtktextbufferrichtext.c
+++ b/gtk/gtktextbufferrichtext.c
@@ -516,7 +516,7 @@ gtk_text_buffer_serialize (GtkTextBuffer     *register_buffer,
 }
 
 /**
- * gtk_text_buffer_serialize:
+ * gtk_text_buffer_deserialize:
  * @register_buffer: the #GtkTextBuffer %format is registered with
  * @content_buffer: the #GtkTextBuffer to deserialize into
  * @format: the rich text format to use for deserializing

diff --git a/gtk/gtktreeview.c b/gtk/gtktreeview.c
index c53d0e0103420dc1d02f0bea7fffe10783ddee88..19c5fffa268399ab199c596e4acd2d7e6549648a 100644 (file)
--- a/gtk/gtktreeview.c
+++ b/gtk/gtktreeview.c
@@ -9853,6 +9853,8 @@ gtk_tree_view_set_headers_clickable (GtkTreeView *tree_view,
  * gtk_tree_view_get_headers_clickable:
  * @tree_view: A #GtkTreeView.
  *
+ * Returns whether all header columns are clickable.
+ *
  * Return value: %TRUE if all header columns are clickable, otherwise %FALSE
  *
  * Since: 2.10
@@ -12663,9 +12665,9 @@ gtk_tree_view_set_search_entry (GtkTreeView *tree_view,
 /**
  * gtk_tree_view_set_search_position_func:
  * @tree_view: A #GtkTreeView
- * @search_position_func: the function to use to position the search dialog
- * @ser_data: user data to pass to @search_position_func, or %NULL
- * @destroy: Destroy notifier for @search_position_data, or %NULL
+ * @func: the function to use to position the search dialog
+ * @data: user data to pass to @func, or %NULL
+ * @destroy: Destroy notifier for @data, or %NULL
  *
  * Sets the function to use when positioning the seach dialog.
  *